org.eclipse.vtp.framework.interactions.voice.services
Class VoicePlatform

java.lang.Object
  org.eclipse.vtp.framework.interactions.core.support.AbstractPlatform
      org.eclipse.vtp.framework.interactions.voice.services.VoicePlatform

All Implemented Interfaces:

IPlatform, VXMLConstants

public class VoicePlatform
extends AbstractPlatform
implements VXMLConstants

A generic implementation of a VXML platform.

Author:

Lonnie Pryor

Field Summary

protected static java.lang.String

VXML_BUILTIN_PREFIX Comment for VXML_BUILTIN_PREFIX.

Fields inherited from interface org.eclipse.vtp.framework.interactions.voice.vxml.VXMLConstants

EMPTY, FILE_EXT_GSL, FILLED_MODE_ALL, FILLED_MODE_ANY, GRAMMAR_MODE_DTMF, GRAMMAR_MODE_VOICE, METHOD_GET, METHOD_POST, MIME_TYPE_GSL, MIME_TYPE_SRGS, NAME_APPLICATION, NAME_ASSIGN, NAME_AUDIO, NAME_BARGEIN, NAME_BEEP, NAME_BLOCK, NAME_BRIDGE, NAME_CATCH, NAME_CHOICE, NAME_COMPLETETIMEOUT, NAME_COND, NAME_CONFIDENCELEVEL, NAME_COUNT, NAME_DEST, NAME_DISCONNECT, NAME_DTMF, NAME_DTMFTERM, NAME_ELSE, NAME_ELSEIF, NAME_ENCTYPE, NAME_ENUMERATE, NAME_ERROR, NAME_EVENT, NAME_EVENTEXPR, NAME_EXIT, NAME_EXPR, NAME_FIELD, NAME_FILLED, NAME_FINALSILENCE, NAME_FORM, NAME_GOTO, NAME_GRAMMAR, NAME_ID, NAME_IF, NAME_INCOMPLETETIMEOUT, NAME_INPUTMODES, NAME_INTERDIGITTIMEOUT, NAME_ITEM, NAME_MAXNBEST, NAME_MAXSPEECHTIMEOUT, NAME_MAXTIME, NAME_MENU, NAME_METHOD, NAME_MODE, NAME_NAME, NAME_NAMELIST, NAME_NEXT, NAME_NOINPUT, NAME_NOMATCH, NAME_ONE_OF, NAME_OPTION, NAME_PARAM, NAME_PROMPT, NAME_PROPERTY, NAME_RECORD, NAME_REPEAT, NAME_REPROMPT, NAME_RETURN, NAME_ROOT, NAME_RULE, NAME_SCOPE, NAME_SCRIPT, NAME_SENSITIVITY, NAME_SPEEDVSACCURACY, NAME_SRC, NAME_SUBDIALOG, NAME_SUBMIT, NAME_TERMCHAR, NAME_TERMTIMEOUT, NAME_THROW, NAME_TIMEOUT, NAME_TRANSFER, NAME_TYPE, NAME_VALUE, NAME_VAR, NAME_VERSION, NAME_VXML, NAMESPACE_URI_VXML, QNAME_XML_LANG, SCOPE_DIALOG, SCOPE_DOCUMENT, TYPE_CDATA, VERSION_2_0

Constructor Summary

VoicePlatform()
Creates a new VoicePlatform.

Method Summary

protected VXMLDocument	createVXMLDocument(ILinkFactory links, Dialog dialog) Creates a new VXML document that contains the supplied dialog.
protected void	generateInitialVariableRequests(java.util.Map variables)
java.lang.String	getInteractionTypeID()
java.lang.String	getNormalizedBoolean(java.lang.String parameter)
protected IDocument	renderBridgeMessage(ILinkFactory links, BridgeMessageCommand bridgeMessageCommand) Renders a bridge message to the user.
protected IDocument	renderDataRequest(ILinkFactory links, DataRequestCommand dataRequestCommand) Renders a data request to the user.
protected IDocument	renderEndMessage(ILinkFactory links, EndMessageCommand endMessageCommand) Renders an end message to the user.
protected IDocument	renderExternalReference(ILinkFactory links, ExternalReferenceCommand externalReferenceCommand) Renders an external reference to the user.
protected IDocument	renderFinalDocument(ILinkFactory links, FinalCommand finalCommand) Renders the final document to the user.
protected IDocument	renderInitialDocument(ILinkFactory links, InitialCommand initialCommand) Renders the initial document to the user.
protected IDocument	renderInputRequest(ILinkFactory links, InputRequestCommand inputRequestCommand) Renders an input request to the user.
protected IDocument	renderOutputMessage(ILinkFactory links, OutputMessageCommand outputMessageCommand) Renders an output message to the user.
protected IDocument	renderSelectionRequest(ILinkFactory links, SelectionRequestCommand selectionRequestCommand) Renders a selection request to the user.
protected IDocument	renderTransferMessage(ILinkFactory links, TransferMessageCommand transferMessageCommand) Renders a transfer message to the user.

Methods inherited from class org.eclipse.vtp.framework.interactions.core.support.AbstractPlatform

createDocument, renderMetaDataMessage, renderMetaDataRequest

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VXML_BUILTIN_PREFIX

protected static final java.lang.String VXML_BUILTIN_PREFIX

Comment for VXML_BUILTIN_PREFIX.

See Also:

Constant Field Values

Constructor Detail

VoicePlatform

public VoicePlatform()

Creates a new VoicePlatform.

Method Detail

createVXMLDocument

protected VXMLDocument createVXMLDocument(ILinkFactory links,
                                          Dialog dialog)

Creates a new VXML document that contains the supplied dialog.

Parameters:

links - The link factory.

dialog - The dialog to add to the new document.

Returns:

A new VXML document that contains the supplied dialog.

renderOutputMessage

protected IDocument renderOutputMessage(ILinkFactory links,
                                        OutputMessageCommand outputMessageCommand)

Description copied from class: AbstractPlatform

Renders an output message to the user.

Overrides:

renderOutputMessage in class AbstractPlatform

Parameters:

links - The link factory to use.

outputMessageCommand - The command to render.

Returns:

The document that was rendered from the command or null if no document could be rendered.

renderInitialDocument

protected IDocument renderInitialDocument(ILinkFactory links,
                                          InitialCommand initialCommand)

Description copied from class: AbstractPlatform

Renders the initial document to the user.

Overrides:

renderInitialDocument in class AbstractPlatform

Parameters:

links - The link factory to use.

initialCommand - The command to render.

Returns:

The document that was rendered from the command or null if no document could be rendered.

generateInitialVariableRequests

protected void generateInitialVariableRequests(java.util.Map variables)

renderInputRequest

protected IDocument renderInputRequest(ILinkFactory links,
                                       InputRequestCommand inputRequestCommand)

Description copied from class: AbstractPlatform

Renders an input request to the user.

Overrides:

renderInputRequest in class AbstractPlatform

Parameters:

links - The link factory to use.

inputRequestCommand - The command to render.

Returns:

The document that was rendered from the command or null if no document could be rendered.

renderSelectionRequest

protected IDocument renderSelectionRequest(ILinkFactory links,
                                           SelectionRequestCommand selectionRequestCommand)

Description copied from class: AbstractPlatform

Renders a selection request to the user.

Overrides:

renderSelectionRequest in class AbstractPlatform

Parameters:

links - The link factory to use.

selectionRequestCommand - The command to render.

Returns:

The document that was rendered from the command or null if no document could be rendered.

renderDataRequest

protected IDocument renderDataRequest(ILinkFactory links,
                                      DataRequestCommand dataRequestCommand)

Description copied from class: AbstractPlatform

Renders a data request to the user.

Overrides:

renderDataRequest in class AbstractPlatform

Parameters:

links - The link factory to use.

dataRequestCommand - The command to render.

Returns:

The document that was rendered from the command or null if no document could be rendered.

renderExternalReference

protected IDocument renderExternalReference(ILinkFactory links,
                                            ExternalReferenceCommand externalReferenceCommand)

Description copied from class: AbstractPlatform

Renders an external reference to the user.

Overrides:

renderExternalReference in class AbstractPlatform

Parameters:

links - The link factory to use.

externalReferenceCommand - The command to render.

Returns:

The document that was rendered from the command or null if no document could be rendered.

renderTransferMessage

protected IDocument renderTransferMessage(ILinkFactory links,
                                          TransferMessageCommand transferMessageCommand)

Description copied from class: AbstractPlatform

Renders a transfer message to the user.

Overrides:

renderTransferMessage in class AbstractPlatform

Parameters:

links - The link factory to use.

transferMessageCommand - The command to render.

Returns:

The document that was rendered from the command or null if no document could be rendered.

renderBridgeMessage

protected IDocument renderBridgeMessage(ILinkFactory links,
                                        BridgeMessageCommand bridgeMessageCommand)

Description copied from class: AbstractPlatform

Renders a bridge message to the user.

Overrides:

renderBridgeMessage in class AbstractPlatform

Parameters:

links - The link factory to use.

bridgeMessageCommand - The command to render.

Returns:

The document that was rendered from the command or null if no document could be rendered.

renderEndMessage

protected IDocument renderEndMessage(ILinkFactory links,
                                     EndMessageCommand endMessageCommand)

Description copied from class: AbstractPlatform

Renders an end message to the user.

Overrides:

renderEndMessage in class AbstractPlatform

Parameters:

links - The link factory to use.

endMessageCommand - The command to render.

Returns:

The document that was rendered from the command or null if no document could be rendered.

renderFinalDocument

protected IDocument renderFinalDocument(ILinkFactory links,
                                        FinalCommand finalCommand)

Description copied from class: AbstractPlatform

Renders the final document to the user.

Overrides:

renderFinalDocument in class AbstractPlatform

Parameters:

links - The link factory to use.

finalCommand - The command to render.

Returns:

The document that was rendered from the command or null if no document could be rendered.

getInteractionTypeID

public java.lang.String getInteractionTypeID()

Specified by:

getInteractionTypeID in interface IPlatform

getNormalizedBoolean

public java.lang.String getNormalizedBoolean(java.lang.String parameter)